/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 - 2008 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/

package com.genia.toolbox.basics.bean;

import java.io.Reader;

import com.genia.toolbox.basics.exception.technical.TechnicalException;

/**
 * interface that represents an object than can convert an object to its xml
 * mapping.
 */
public interface Unmarshaller
{

  /**
   * Unmarshal XML data from the specified file and return the resulting content
   * tree.
   * <p>
   * Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>.
   * 
   * @param file
   *          the file to unmarshal XML data from
   * @return the newly created root object of the java content tree
   * @throws TechnicalException
   *           If any unexpected errors occur while unmarshalling
   */
  public Object unmarshal(java.io.File file)
      throws TechnicalException;



  /**
   * Unmarshal XML data from the specified InputStream and return the resulting
   * content tree. Validation event location information may be incomplete when
   * using this form of the unmarshal API.
   * <p>
   * Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>.
   * 
   * @param is
   *          the InputStream to unmarshal XML data from
   * @return the newly created root object of the java content tree
   * @throws TechnicalException
   *           If any unexpected errors occur while unmarshalling
   */
  public Object unmarshal(java.io.InputStream is)
      throws TechnicalException;



  /**
   * Unmarshal XML data from the specified Reader and return the resulting
   * content tree. Validation event location information may be incomplete when
   * using this form of the unmarshal API, because a Reader does not provide the
   * system ID.
   * <p>
   * Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>.
   * 
   * @param reader
   *          the Reader to unmarshal XML data from
   * @return the newly created root object of the java content tree
   * @throws TechnicalException
   *           If any unexpected errors occur while unmarshalling
   */
  public Object unmarshal(Reader reader)
      throws TechnicalException;

}
